diff --git a/README-advanced.md b/README-advanced.md new file mode 100644 index 0000000..60a06bf --- /dev/null +++ b/README-advanced.md @@ -0,0 +1,40 @@ +## Advanced topics + +### Manual setup + +If you did not run the user-setup script (see "Automated setup" section in the +[main README](README.md), you will want to set up the developer tooling +workspace manually. This section provides general documentation for the manual +setup process, and it is not meant to be exhaustive. + +On your Clear Linux system, create a workspace for Clear Linux development +work: + +``` +$ mkdir clearlinux +``` + +Clone this repo into a `projects` directory within the workspace: + +``` +$ cd clearlinux +$ mkdir projects +$ git clone https://github.com/clearlinux/common projects/common +``` + +Create the toplevel tooling Makefile: + +``` +$ ln -s projects/common/Makefile.toplevel Makefile +``` + +Clone all Clear Linux package and project repositories: + +``` +$ make clone +``` + +Note: You can clone the repos in parallel by using make's `-j` option. + +At this point, the `packages` directory will contain all Clear Linux package +repos, and `projects` will contain common, clr-bundles, and autospec repos. diff --git a/README.md b/README.md index a583a26..cc628b6 100644 --- a/README.md +++ b/README.md @@ -152,39 +152,4 @@ If `Makefile.config.site_local` doesn't exist already, create it. ### Manual setup -If you did not run the user-setup script (see "Automated setup" section above), -you will want to set up the developer tooling workspace manually. This section -provides general documentation for the manual setup process, and it is not -meant to be exhaustive. - -On your Clear Linux system, create a workspace for Clear Linux development -work: - -``` -$ mkdir clearlinux -``` - -Clone this repo into a `projects` directory within the workspace: - -``` -$ cd clearlinux -$ mkdir projects -$ git clone https://github.com/clearlinux/common projects/common -``` - -Create the toplevel tooling Makefile: - -``` -$ ln -s projects/common/Makefile.toplevel Makefile -``` - -Clone all Clear Linux package and project repositories: - -``` -$ make clone -``` - -Note: You can clone the repos in parallel by using make's `-j` option. - -At this point, the `packages` directory will contain all Clear Linux package -repos, and `projects` will contain common, clr-bundles, and autospec repos. +See the [Manual setup](README-advanced.md#manual-setup) documentation.