From a19410aab3aa6e7061f98d5a77b5f23d0bc9f794 Mon Sep 17 00:00:00 2001 From: KristinaGomoryova Date: Mon, 15 Jul 2024 10:21:03 +0200 Subject: [PATCH] next steps and notice files deleted --- NOTICE | 2 -- next_steps.md | 47 ----------------------------------------------- 2 files changed, 49 deletions(-) delete mode 100644 NOTICE delete mode 100644 next_steps.md diff --git a/NOTICE b/NOTICE deleted file mode 100644 index 965c3ce..0000000 --- a/NOTICE +++ /dev/null @@ -1,2 +0,0 @@ -This product includes rcx_tk, software developed by -Netherlands eScience Center. diff --git a/next_steps.md b/next_steps.md deleted file mode 100644 index affbc71..0000000 --- a/next_steps.md +++ /dev/null @@ -1,47 +0,0 @@ -# Next steps - -## Put the generated files under version control - -Once your Python package is created, put it under [version -control](https://guide.esciencecenter.nl/#/best_practices/version_control) using -[git](https://git-scm.com/) and [GitHub](https://github.com/). - -Note that the next step assumes you have setup your connection to GitHub via SSH, -see [Connecting to GitHub with SSH](https://docs.github.com/en/github-ae@latest/authentication/connecting-to-github-with-ssh). - -Alternatively, you can also use a personal access token, see -[Creating a personal access token](https://docs.github.com/en/github-ae@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). If you choose this option, below you will have to replace -`git@github.com:` by `https://github.com/`. - -```shell -cd rcx-tk -git init -git add --all -git commit -m "first commit" -git branch -M main -git remote add origin git@github.com:RECETOX/rcx-tk -``` - -## Push the initial commit to a new repo on GitHub - -Go to -[https://github.com/organizations/RECETOX/repositories/new](https://github.com/organizations/RECETOX/repositories/new) -and create a new repository named `rcx-tk` as an empty repository, then push your commits to GitHub: - -```shell -git push --set-upstream origin main -``` - -## Check automatically generated issues - -A short while after you push your commits to GitHub for the first time, a few issues outlining next steps will added -automatically ([here](https://github.com/RECETOX/rcx-tk/issues?q=author%3Aapp%2Fgithub-actions)). Resolve them to complete the -setup of your repository. - -## Project development documentation - -The [README.dev.md](README.dev.md) contains developer documentation. - -## Project layout explained - -For an explanation of what files are there, and what each of these do, please refer to [project_setup.md](project_setup.md).