NERDDISCO commited on
Commit
c49bfa2
β€’
1 Parent(s): d69324d

docs: info about "gitlfs" and which things need to be replaced exactly

Browse files
Files changed (1) hide show
  1. README.md +4 -2
README.md CHANGED
@@ -47,11 +47,13 @@ This will build the project as a standalone app inside the Docker image.
47
 
48
  If you want to use all the features for collaborative development on GitHub, but keep your demo on Spaces, then you can set up a GitHub action that will automatically push changes from GitHub into Spaces.
49
 
 
 
50
  1. Create your repo on GitHub
51
  2. Create a [Github secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) named `HF_TOKEN` and use an [access token from Hugging Face](https://huggingface.co/settings/tokens) as its value (you must be logged in to do this)
52
  3. Update the workflow [sync_to_hf_spaces.yml](.githug/worfkows/sync_to_hf_spaces.yml)
53
- a. Configure `HF_USERNAME` with the name of your user or your organization
54
- b. Configure `HF_SPACE_NAME` with the name of your space
55
  4. Push the code into your repo on GitHub
56
 
57
  This should force push changes in the **main** branch from GitHub into your πŸ€— space.
 
47
 
48
  If you want to use all the features for collaborative development on GitHub, but keep your demo on Spaces, then you can set up a GitHub action that will automatically push changes from GitHub into Spaces.
49
 
50
+ > ℹ️ Git-LFS is required for files bigger than 10MB
51
+
52
  1. Create your repo on GitHub
53
  2. Create a [Github secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) named `HF_TOKEN` and use an [access token from Hugging Face](https://huggingface.co/settings/tokens) as its value (you must be logged in to do this)
54
  3. Update the workflow [sync_to_hf_spaces.yml](.githug/worfkows/sync_to_hf_spaces.yml)
55
+ a. Configure `HF_USERNAME`: Replace `failfast` with the name of your πŸ€— user account or your πŸ€— organization
56
+ b. Configure `HF_SPACE_NAME`: Replace `nextjs-docker-starter` with the name of your πŸ€— space
57
  4. Push the code into your repo on GitHub
58
 
59
  This should force push changes in the **main** branch from GitHub into your πŸ€— space.