From 01b0977df60fc9b5f255638d724056002add41e1 Mon Sep 17 00:00:00 2001 From: Mark Joshwel Date: Mon, 22 Jul 2024 17:38:02 +0800 Subject: [PATCH] docs: fix grammar + remove brand guideline stuff --- README.md | 27 ++++++++++----------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 896cdfb..b6086d2 100644 --- a/README.md +++ b/README.md @@ -64,10 +64,6 @@ Modelling | Lead | Mark | |:----:|:----:| -if it involves the brand: -follow the brand guidelines -at [Documentation/sota staircase Brand Guidelines.pdf](Documentation/sota%20staircase%20Brand%20Guidelines.pdf) - and then send it to mark for approval (●'◡'●) anything that can be saved locally (including figma files, btw) _should_ be saved @@ -100,7 +96,7 @@ organise as you wish but make sure it's logical | Lead | kinda everyone more so mark | |:----:|:---------------------------:| -for this, just discuss with the group; either through the telegram group or through an issue +for this, discuss with the group; either through the telegram group or through an issue on [the forge](https://forge.joshwel.co/mark/sota/issues) ### on Documentation (for All Modules) @@ -108,9 +104,6 @@ on [the forge](https://forge.joshwel.co/mark/sota/issues) | Lead | kinda everyone more so mark | |:----:|:---------------------------:| -follow the brand guidelines -at [Documentation/sota staircase Brand Guidelines.pdf](Documentation/sota%20staircase%20Brand%20Guidelines.pdf) - source files (.docx, .fig, etc.) should be in the respective modules' directory, and then exported as .pdfs to `Documentation/*.pdf` @@ -149,7 +142,7 @@ the following command line arguments can be used: useful if you _know_ you've already generated one beforehand - `--test` - does everything except actually pushing to github + does everything except actually pushing to GitHub there's more, but god forbid you need to use them unless you're changing the script, search for `argv` in the script if you're comfortable with dragons @@ -157,7 +150,7 @@ search for `argv` in the script if you're comfortable with dragons #### SideStepper and the .sotaignore file the `.sotaignore` file is a file that tells the sync script what to ignore when syncing -to github, and should be in the root of the repository +to GitHub, and should be in the root of the repository it is automatically generated by the sync script and should not be manually edited unless there's a file we want to exclude @@ -192,7 +185,7 @@ the following environment variables can be set: - `SOTA_SIDESTEP_PARALLEL` whether to use multiprocessing for large file finding, default is false - hilariously it's ~4-5x slower than single-threaded file finding, but the option + hilariously, it's ~4-5x slower than single-threaded file finding, but the option is still present because it was made before the fourth implementation of the large file finding algorithm (now called SideStepper because names are fun, sue me) @@ -204,8 +197,8 @@ the following command line arguments can be used: ## Licence and Credits -"NP resources" hereby refers to resources provided by Ngee Ann Polytechnic (NP) for the -development of the project +"NP resources" hereby refers to resources provided by Ngee Ann Polytechnic (NP) for use +in student work during the course of our study 1. software source code @@ -217,7 +210,7 @@ development of the project 2. models made with ["extensive use of NP resources"](https://www.np.edu.sg/student_ip): - specifically coming from, or in part have had the following software and/or + specifically, coming from or in part has had the following software and/or services involved: - Autodesk Maya @@ -229,7 +222,7 @@ development of the project - Substance 3D Stager - Substance 3D Assets - would be all rights reserved, unless otherwise stated + would have all rights reserved, unless otherwise stated (_i mean mr q said this already lol_) @@ -245,7 +238,7 @@ development of the project **disclaimer**: the creative lead (mark) has been using adobe software even [before enrolling into np](https://github.com/markjoshwel/portfolio-eae/blob/main/public/assets/skill-adobe.png), - so whether it's "extensive use" is fair game lol + so whether it is "extensive use" is fair game lol (_also yea I don't really have a better example than my eae portfolio oops_) @@ -261,6 +254,6 @@ exceptions to the above licences are as follows: > Example: > > - Frogman by Frog Creator: Standard Unity Asset Store EULA (Extension Asset) - > `Assets/Characters/Frogman` +> `Assets/Characters/Frogman` > > comma-separate multiple licences, and use code blocks if you need to list multiple files/directories/patterns