forked from caten/DiscreteNeuralNets
Added Git workflow
This commit is contained in:
parent
7d6442d0ac
commit
a37577095b
13
README.md
13
README.md
|
@ -4,6 +4,19 @@ discrete neural net and polymorphic learning in Python. For more information on
|
||||||
these notions, see
|
these notions, see
|
||||||
[the corresponding preprint](https://arxiv.org/abs/2308.00677) on the arXiv.
|
[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
|
### Project structure
|
||||||
The scripts that define basic components of the system are in the `src` folder.
|
The scripts that define basic components of the system are in the `src` folder.
|
||||||
These are:
|
These are:
|
||||||
|
|
Loading…
Reference in a new issue