Compare commits

...

3 Commits

Author SHA1 Message Date
81314c731a Improved README
Some checks failed
checks-impure / test (pull_request) Successful in 31s
checks / test (pull_request) Failing after 1m51s
2023-12-03 18:39:19 +01:00
38ec5c891d Improved README 2023-12-03 18:38:58 +01:00
32b4df127a Better README 2023-12-03 14:22:46 +01:00

View File

@@ -26,6 +26,12 @@ Let's get your development environment up and running:
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
```
On Windows Subsystem for Linux (WSL) the installer will fail and tell you what to do. Execute the command from the error message and then afterwards execute:
```bash
sudo echo "experimental-features = nix-command flakes" > '/etc/nix/nix.conf'
```
2. **Install direnv**:
- Download the direnv package from [here](https://direnv.net/docs/installation.html) or run the following command:
@@ -95,19 +101,19 @@ Let's set up your Git workflow to collaborate effectively:
```bash
tea login add
```
- Go to https://gitea.gchq.icu/user/settings/applications and create token with all privileges
- Fill out the prompt as follows:
- URL of Gitea instance: `https://gitea.gchq.icu`
- Name of new Login [gitea.gchq.icu]: `gitea.gchq.icu:7171`
- Do you have an access token? No
- Username: YourUsername
- Password: YourPassword
- Do you have an access token? Yes
- Token: ****\*****
- Set Optional settings: No
2. **Git Workflow**:
1. Add your changes to Git using `git add <file1> <file2>`.
2. Run `nix fmt` to lint your files.
3. Commit your changes with a descriptive message: `git commit -a -m "My descriptive commit message"`.
2. Run `nix fmt` to lint your files. This will format your files and make changes!
3. Commit your changes and those of nix fmt with a descriptive message: `git commit -a -m "My descriptive commit message"`.
4. Make sure your branch has the latest changes from upstream by executing:
```bash
git fetch && git rebase origin/main --autostash