diff --git a/How to Use GitHub for AREDN.md b/How to Use GitHub for AREDN.md index c15ed956..507b3341 100644 --- a/How to Use GitHub for AREDN.md +++ b/How to Use GitHub for AREDN.md @@ -9,7 +9,7 @@ To contribute to the AREDN project you first must create your own GitHub account 1. Open your web browser and navigate to the GitHub URL `https://github.com`. 2. Click the `Sign Up` button and enter a username, email, and password. We suggest using your callsign as the username which will be indicated below as "myCall". You can, however, create any username you desire. Substitute your actual GitHub username for "myCall" in the examples below. 3. On the GitHub website, click the `Sign In` button and enter your username or email, followed by your github password. -4. You can enter "aredn" into the search bar to find all repositories related to AREDN, or if you want to contribute directly to the AREDN firmware you can type this URL into your web browser: `https://github.com/aredn/aredn_ar71xx`. +4. You can enter "aredn" into the search bar to find all repositories related to AREDN, or if you want to contribute directly to the AREDN firmware you can type this URL into your web browser: `https://github.com/aredn/aredn`. ### Understanding GitHub Workflow @@ -21,11 +21,11 @@ When you are satisfied with your changes, stage and COMMIT them to your local co #### One-time Repository Setup: -1. Login to your own GitHub account and navigate in your browser to `https://github.com/aredn/aredn_ar71xx` +1. Login to your own GitHub account and navigate in your browser to `https://github.com/aredn/aredn` 2. Click the `Fork` button on the upper right side of the page. You now have a copy of the AREDN source code on your own GitHub account. -3. Go to your local computer and copy your fork of the AREDN source code: `git clone https://github.com/[myCall]/aredn_ar71xx` -4. `cd aredn_ar71xx` This directory contains your local copy of the AREDN source code. The following commands will be executed while you are in this directory or its subdirectories. -5. `git remote add aredn https://github.com/aredn/aredn_ar71xx` +3. Go to your local computer and copy your fork of the AREDN source code: `git clone https://github.com/[myCall]/aredn` +4. `cd aredn` This directory contains your local copy of the AREDN source code. The following commands will be executed while you are in this directory or its subdirectories. +5. `git remote add aredn https://github.com/aredn/aredn` Now your local environment knows about both the master code repository and your forked copy on your GitHub account. @@ -50,7 +50,7 @@ Now your local environment knows about both the master code repository and your 1. `git add [any-changed-files]` (stage changes for commit) 2. `git commit` (Be sure to commit your changes with a meaningful commit message. You can refer to the standards used by OpenWRT for creating commit descriptions that are easy for others to understand. The key is a commit description that concisely communicates to others what is in the commit.) 3. `git push origin my-wiz-bang-feature-name` -6. Create a `Pull Request` (PR) to the AREDN master repository by browsing to `github.com/[myCall]/aredn_ar71xx`, then select the my-wiz-bang-feature-name branch. Click the `New Pull Request` button to generate your Pull Request. Others can now review your code, test it, and give feedback. If feedback is given and you need to make changes, go back to step 3. +6. Create a `Pull Request` (PR) to the AREDN master repository by browsing to `github.com/[myCall]/aredn`, then select the my-wiz-bang-feature-name branch. Click the `New Pull Request` button to generate your Pull Request. Others can now review your code, test it, and give feedback. If feedback is given and you need to make changes, go back to step 3. 7. Once your changes have been accepted into the AREDN master repository, delete your branch: 1. On your local repository: `git branch -D my-wiz-bang-feature-name` 2. On your forked copy of your GitHub repository: `git push origin --delete my-wiz-bang-feature-name` diff --git a/README.md b/README.md index e49b8733..1da9f58c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ http://www.arednmesh.org +THIS IS A NEW REPO THAT IS IN PROGRESS - DO NOT USE YET + + ## About AREDN AREDN wireless networks are deployed by licensed Amateur Radio @@ -43,7 +46,7 @@ features and the overall mesh node is stable. The more participation, the earlier an issue is found, the faster an enhancement will be turned into a release. -Please refer to https://github.com/aredn/aredn_ar71xx/issues +Please refer to https://github.com/aredn/aredn/issues for a list of outstanding defects. ### Images built @@ -169,7 +172,7 @@ IMPORTANT: For Gl.iNet devices, when initially installing AREDN on OpenWRT, you ## Submitting Bug Reports -Please submit all issues to http://github.com/aredn/aredn_ar71xx/issues +Please submit all issues to http://github.com/aredn/aredn/issues ## Developer Only Information @@ -187,7 +190,7 @@ docker run -it --name builder arednmesh/builder To pull an image (or any other file) out of the docker container: ``` -docker cp builder:/opt/aredn/aredn_ar71xx/firmware/targets/ar71xx/generic/.bin +docker cp builder:/opt/aredn/aredn/firmware/targets/ar71xx/generic/.bin ``` ### Build Prerequisites @@ -222,8 +225,8 @@ To obtain the source and build the firmware locally use: ``` bash -git clone https://github.com/aredn/aredn_ar71xx.git -cd aredn_ar71xx +git clone https://github.com/aredn/aredn.git +cd aredn vi config.mk # enter your callsign, etc. # build default legacy ar71xx target ubnt and tplink images make @@ -246,7 +249,7 @@ You need approximately 10GB of space for the build. ### How to build prior builds of AREDN Prior AREDN images can be rebuilt. Replace one of the following after -the "cd aredn_ar71xx" command above: +the "cd aredn" command above: AREDN release 3.20.3.1 @@ -346,11 +349,11 @@ quilt refresh # creates/updates the patch file ## Submitting new features and patches to AREDN -The high level steps to submit to this repository https://github.com/aredn/aredn_ar71xx are: +The high level steps to submit to this repository https://github.com/aredn/aredn are: 1) create a github account and 'fork' this repo -2) git commit a change into your fork, e.g. http://github.com/ae6xe/aredn_ar71xx -3) create a pull request for http://github.com/aredn/aredn_ar71xx to consider your change +2) git commit a change into your fork, e.g. http://github.com/ae6xe/aredn +3) create a pull request for http://github.com/aredn/aredn to consider your change