Skip to content

Commit

Permalink
fix lua api links and update references to 'main' branch (#1327)
Browse files Browse the repository at this point in the history
  • Loading branch information
jayzmiles authored Mar 14, 2021
1 parent 1219341 commit b1d5b00
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
contributing
==================================

[![Build Status](https://travis-ci.org/monome/norns.svg?branch=master)](https://travis-ci.org/monome/norns)
[![Build Status](https://travis-ci.org/monome/norns.svg?branch=main)](https://travis-ci.org/monome/norns)

welcome
-------
Expand All @@ -27,7 +27,7 @@ getting the code and configuring your environment
* `git clone https://github.com/<your_name_here>/norns.git`
* `cd norns`
* `git remote add upstream https://github.com/monome/norns.git` (so that you
fetch from the master repository, not your clone, when running `git fetch`
fetch from the main repository, not your clone, when running `git fetch`
et al.)

contributing code
Expand All @@ -36,7 +36,7 @@ contributing code
to start working on a patch:

* `git fetch upstream`
* `git checkout upstream/master -b name_of_your_branch`
* `git checkout upstream/main -b name_of_your_branch`
* hack away
* `git commit -a -m "<your brief but informative commit message>"`
* `git push origin name_of_your_branch`
Expand All @@ -53,14 +53,14 @@ to send us a pull request (pr):

once everyone is happy, a maintainer will merge your pr for you.

api docs for master
api docs for main
-------------------

to view the api docs for the `master` branch,
visit https://monome.github.io/norns/doc/.
to view the api docs for the `main` branch,
visit https://monome.org/docs/norns/api.

those docs should be updated after a successful travis build
of the norns `master` branch.
of the norns `main` branch.


build infrastructure
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

general documentation is in [github.com/monome/docs](https://github.com/monome/docs).

Lua api docs are hosted on [monome.github.io/norns/doc](https://monome.github.io/norns/doc/).
Lua api docs are hosted on [monome.org/docs/norns/api](https://monome.org/docs/norns/api).

see [readme-setup.md](readme-setup.md) for build, install, configuration, and execution.

Expand Down

0 comments on commit b1d5b00

Please sign in to comment.