diff --git a/README.md b/README.md index fa90ff9d935804fe6fcb31bb54b81cccc42b6b7a..3cbb2018c81418f8611a15c82d7a1488c2d40a22 100644 --- a/README.md +++ b/README.md @@ -2,91 +2,99 @@ Main Class Project page for SYN100: Digitally Documenting Climatic Change -## Getting started +## Course Description -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +In this course, students will work in cross-disciplinary groups to design projects around the problem of digital documentation of climatically endangered sites. -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +Climatically endangered natural and cultural heritage sites are disappearing at a rapid pace. Their digital documentation can both preserve our knowledge of their current state but also serve as a tool for education and communication on climatic change to a broad audience. A special emphasis of the class will be on utilizing VR/AR, photogrammetry, GIS, and gaming engines as platforms of digital documentation and dissemination. You will develop through this class skills in modern software tools such as the Unreal Engine 5, ArcGIS, and Reality Capture. The course is open to all majors and will introduce students to the topics and related tools mentioned above. -## Add your files +## Purpose of this Repo -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +This class repository will serve as a launching point and resource for student projects created under the theme of Digitally Documenting Climatic Change. It will also house student resumes and will be the first repo you learn to contribute to when you take the first class tutorial. Please use this repo as a template for creating your project repos. -``` -cd existing_repo -git remote add origin https://gitlab.nrp-nautilus.io/syn100/digitally-documenting-climatic-change.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitlab.nrp-nautilus.io/syn100/digitally-documenting-climatic-change/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy +## Git Cheat Sheet -Use the built-in continuous integration in GitLab. +Install Git: + Windows: https://github.com/git-for-windows/git/releases/download/v2.37.3.windows.1/Git-2.37.3-64-bit.exe -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README + MaxOS: Install homebrew if you don't already have it, then: +``` +$ brew install git +``` -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. +Open a command line/terminal: -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +Windows: +Option 1: Open file explorer and navigate to your project folder and right click on it. Select Git Bash Here (If on Windows 11 first select "Show more options") +Option 2: Click the windows button and type in "cmd" and select "Command Prompt" app. +Go to your root directory: +``` +cd\ +``` -## Name -Choose a self-explaining name for your project. +Then type "cd" and then enter the directory you want to navigate to, for example (Hint: hit tab to autocomplete what you are typing): +``` +cd Projects/SYN100 +``` -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +MacOS: +Click the Launchpad icon in the Dock, type Terminal in the search field, then click Terminal. -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +Go to your root directory: +``` +cd\ +``` +Then type "cd" and then enter the directory you want to navigate to, for example (Hint: hit tab to autocomplete what you are typing): +``` +cd Projects/SYN100 +``` -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +Clone this project: +``` +git clone https://gitlab.nrp-nautilus.io/syn100/digitally-documenting-climatic-change.git -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +``` -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. +Setup your name and email for gitlab (Use the email you signed into gitlab) +``` +git config --global user.name "FIRST_NAME LAST_NAME" +git config --global user.email "MY_NAME@example.com" +``` -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +Find out what files you have modified or added to your local repo: +``` +cd digitally-documenting-climatic-change +git status +``` -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +Add untracked files to your local repo: +``` +git add yournewfilename.extension +``` +You can also add a whole folder of files: +``` +git add thefoldername +``` -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +Commit your changes to the local repo: +``` +git commit -am "note about your commit" +``` -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +Push your changes to the remote repo on gitlab +``` +git push +``` -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +Pull changes made by others to your local repo: +``` +git pull +``` -## License -For open source projects, say how it is licensed. +cd existing_repo +git remote add origin https://gitlab.nrp-nautilus.io/syn100/digitally-documenting-climatic-change.git +git branch -M main +git push -uf origin main +``` -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. diff --git a/Resumes/Add_your_resumes_here.md b/Resumes/Add_your_resumes_here.md new file mode 100644 index 0000000000000000000000000000000000000000..07a4e9854704949d659b058f41a3edbb93a77101 --- /dev/null +++ b/Resumes/Add_your_resumes_here.md @@ -0,0 +1,20 @@ +First update your local repo with other student's contributions: +``` +git pull +``` + +Add your resumes to this folder: + Copy your resume into this folder on your local computer, then: + ``` + git add Resumes/yourresumefile + ``` + +Commit your resume: +``` +git commit -am "Your name" +``` + +Upload/Push your resume to gitlab: +``` +git push +``` \ No newline at end of file diff --git a/SYN100_FA22_Smith_Syllabus.pdf b/SYN100_FA22_Smith_Syllabus.pdf new file mode 100644 index 0000000000000000000000000000000000000000..7f6a8a5fd69f9adf0a9dd775cf67ff887ea19117 Binary files /dev/null and b/SYN100_FA22_Smith_Syllabus.pdf differ