diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 31cddd1ba..4f21fd19a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -171,11 +171,11 @@ Please copy and paste the following quotes for the languages: ## Docker – More Closely -### Apple M1 Platform +### Apple Silicon Platform -***Attention:** For using Docker commands in Apple M1 environments!* +***ATTENTION:** For using Docker commands in Apple Silicon environments!* -#### Environment Variable For Apple M1 Platform +#### Environment Variable For Apple Silicon Platform (M1, M2 Chips) If you encounter trouble building the docker containers on an Apple M1 chip you can try to explicitly define the target platform docker builds and pulls images for: diff --git a/README.md b/README.md index 1cffbf027..0c68435a8 100644 --- a/README.md +++ b/README.md @@ -122,19 +122,19 @@ Clone the repository, this will create a new folder called `Ocelot-Social`: Using HTTPS: ```bash -$ git clone https://github.com/Ocelot-Social-Community/Ocelot-Social.git +git clone https://github.com/Ocelot-Social-Community/Ocelot-Social.git ``` Using SSH: ```bash -$ git clone git@github.com:Ocelot-Social-Community/Ocelot-Social.git +git clone git@github.com:Ocelot-Social-Community/Ocelot-Social.git ``` Change into the new folder. ```bash -$ cd Ocelot-Social +cd Ocelot-Social ``` ### Live Demo and Developer Logins @@ -172,7 +172,9 @@ Check the correct Docker installation by checking the version before proceeding. $ docker --version ``` -##### Start Ocelot-Social via Docker-Compose +##### Start Ocelot-Social via Docker Compose + +***ATTENTION:** For using Docker commands in Apple Silicon environments see [here](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/CONTRIBUTING.md#apple-silicon-platform).* Prepare ENVs once beforehand: @@ -233,7 +235,7 @@ We are happy if you fork our repository, but we don't recommend it for developme Clone this repository locally as [described above](#clone-the-repository), create your branch named `-`, add your code and push your branch direct to this repository. Then create a PR by comparing it to our `master`. -**_!!! Be aware:_** Please don't compare from a fork, because the tests are breaking caused by credential problems. +***!!! Be aware:*** Please don't compare from a fork, because the tests are breaking caused by credential problems. Please run the following commands before you push: