andreas/mac_os
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated project documentation to conform to Rubysmith template

Browse Source 
Necessary to match consistency used by the
[Rubysmith](https://www.alchemists.io/projects/rubysmith) when
building/maintaining projects.
This commit is contained in:
Brooke Kuhlmann
2020-10-13 20:07:16 -06:00
parent e533bf04be
commit b6cddae599
3 changed files with 14 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CODE_OF_CONDUCT.adoc
View File

@@ -51,7 +51,8 @@ an appointed representative at an online or offline event.
== Enforcement == Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
leaders responsible for enforcement at link:mailto:brooke@alchemists.io?subject=Conduct[Alchemists]. leaders responsible for enforcement at link:mailto:brooke@alchemists.io?subject=Conduct[Brooke Kuhlmann].
All complaints will be reviewed and investigated promptly and fairly. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any All community leaders are obligated to respect the privacy and security of the reporter of any
@@ -102,7 +103,7 @@ disparagement of classes of individuals.
This Code of Conduct is adapted from the This Code of Conduct is adapted from the
link:https://www.contributor-covenant.org/version/2/0/code_of_conduct.html[Contributor Covenant, link:https://www.contributor-covenant.org/version/2/0/code_of_conduct.html[Contributor Covenant,
version 2.0]. Version 2.0].
Community Impact Guidelines were inspired by link:https://github.com/mozilla/diversity[Mozilla's Community Impact Guidelines were inspired by link:https://github.com/mozilla/diversity[Mozilla's
code of conduct enforcement ladder]. code of conduct enforcement ladder].

2
LICENSE.adoc
View File

@@ -150,7 +150,7 @@ additional liability.
END OF TERMS AND CONDITIONS END OF TERMS AND CONDITIONS
Copyright link:https://www.alchemists.io[Alchemists]. Copyright 2016 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy] compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]

22
README.adoc
View File

@@ -51,8 +51,6 @@ image::https://www.alchemists.io/images/screencasts/mac_os/cover.svg[Screencast,
== Setup == Setup
=== Production
To install, run: To install, run:
[source,bash] [source,bash]
@@ -62,16 +60,6 @@ cd mac_os
git checkout 9.0.0 git checkout 9.0.0
---- ----
=== Development
To contribute, run:
[source,bash]
----
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
----
== Usage == Usage
Run the following: Run the following:
@@ -221,6 +209,16 @@ link:https://www.alchemists.io/projects/mac_os-config[macOS Config] project for
your system, the version might differ, so look for a `*.pkg` in the your system, the version might differ, so look for a `*.pkg` in the
`/Library/Developer/CommandLineTools/Packages` folder. `/Library/Developer/CommandLineTools/Packages` folder.
== Development
To contribute, run:
[source,bash]
----
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
----
== Versioning == Versioning
Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means: Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means: