caten/DiscreteNeuralNets
1
0
Fork 3
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Added Git workflow

Browse source
This commit is contained in:
Charlotte Aten 2025-07-21 09:04:13 -06:00
parent 7d6442d0ac
commit a37577095b
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -4,6 +4,19 @@ discrete neural net and polymorphic learning in Python. For more information on
these notions, see
[the corresponding preprint](https://arxiv.org/abs/2308.00677) on the arXiv.
### Git workflow
1) Fork main repo (http://git.aten.cool/caten/DiscreteNeuralNets). This is
different than just cloning. There is a button on Forgejo for this.
2) Clone your fork to your machine.
3) Make a branch on your machine.
4) At any time, you can push your changes to your personal fork of the repo.
5) On your machine, pull from the main repo's main branch.
6) On your machine, merge the main branch into your new branch.
7) Resolve any conflicts that arise, then merge your new branch into the main
branch.
8) Push your work to your personal fork of the repo.
9) Make a pull request to pull your fork's main into the original repo's main.
### Project structure
The scripts that define basic components of the system are in the `src` folder.
These are: