-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moved repo to acfr github, changed README.md accordingly
- Loading branch information
1 parent
095be85
commit c75b116
Showing
2 changed files
with
4 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,7 +8,7 @@ Julia package for Recurrent Equilibrium Networks. This package is a work-in-prog | |
|
||
So far, the package only contains a couple of test functions. To install the package for development: | ||
- Clone the repository into your Julia dev folder: | ||
- For Linux/Mac, use: `git clone [email protected]:nic-barbara/RecurrentEquilibriumNetworks.jl.git RecurrentEquilibriumNetworks` inside your `~/.julia/dev/` directory. | ||
- For Linux/Mac, use: `git clone [email protected]:acfr/RecurrentEquilibriumNetworks.jl.git RecurrentEquilibriumNetworks` inside your `~/.julia/dev/` directory. | ||
- Note that the repo is `RecurrentEquilibriumNetworks.jl`, but the folder is `RecurrentEquilibriumNetworks`. This is convention for Julia packages. | ||
- Navigate to the repo directory, start the Julia REPL, and type `] activate .` to activate the package. | ||
- Try using the demo functions: | ||
|
@@ -25,9 +25,9 @@ To contribute to the package: | |
- Use git to pull/push changes to the package as normal | ||
|
||
To use the package in a separate Julia workspace: | ||
- Add development version of the package with: `] dev [email protected]:nic-barbara/RecurrentEquilibriumNetworks.jl.git` | ||
- Add development version of the package with: `] dev [email protected]:acfr/RecurrentEquilibriumNetworks.jl.git` | ||
- This is instead of the usual `] add` command. We also have to use the git link not the package name because it is an unregistered Julia package. | ||
- Whenever you use the package, it will access the latest version in your `.julia/dev/` folder rather than the stable release in the `main` branch. This is easiest for development while we frequently change the package. | ||
- To use the code on the current main branch of the repo (latest stable release), instead type `] add [email protected]:nic-barbara/RecurrentEquilibriumNetworks.jl.git`. You will have to manually update the package as normal with `] update RecurrentEquilibriumNetworks`. | ||
- To use the code on the current main branch of the repo (latest stable release), instead type `] add [email protected]:acfr/RecurrentEquilibriumNetworks.jl.git`. You will have to manually update the package as normal with `] update RecurrentEquilibriumNetworks`. | ||
|
||
Email Nic Barbara ([email protected]) for any questions/concerns. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters