From fa1f8bf212910c388d8d9911354a36f799f5a903 Mon Sep 17 00:00:00 2001
From: dh00601 <dh00601@surrey.ac.uk>
Date: Thu, 11 Aug 2022 22:16:17 +0100
Subject: [PATCH] updated readme
---
README.md | 12 ++++--------
docs/source/index.rst | 2 +-
2 files changed, 5 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 598b9c1c9..3ed405726 100644
--- a/README.md
+++ b/README.md
@@ -99,15 +99,11 @@ from within the `commands/` directory
### Running unit tests
There are two versions of the general unit tests. The first includes only the actual code of the project, and is located at `binarycpython/test/main.py`. The second includes the tutorial notebooks, and is located at `binarycpython/test/main_with_notebooks.py`. To run just the notebook tests run `python binarycpython/tests/test_notebooks.py`
-### Pulling the JOSS paper article repo
-We've written a JOSS paper for `binary_c-python`, which is stored in https://gitlab.com/dhendriks/paper_joss_binarycpython, but is also added as a submodule to this repository. To initialise and pull the repo as a submodule, run
+## Submitting an issue or suggestion features/changes
+If you encounter an issue with the code, or if you want to suggest extra features or changes in the code, please submit an issue at https://gitlab.com/binary_c/binary_c-python/-/issues/new.
-```
-git submodule update --init --recursive
-```
-
-## FAQ/Issues:
-Here we provide a non-exhaustive list of some issues we encountered and solutions for these:
+## FAQ:
+Here we provide a non-exhaustive list of some installation issues we encountered and solutions for these:
Building issues with binary_c itself:
- see the documentation of binary_c (in doc/).
diff --git a/docs/source/index.rst b/docs/source/index.rst
index dd3e4bb0c..ceb0a87a4 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -18,7 +18,7 @@ Welcome to binary_c-python's documentation!
binary_c_parameters
grid_options_descriptions
Visit the GitLab repo <https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python>
- Submit an issue <https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python/-/issues/new>
+ Submit an issue <https://gitlab.com/binary_c/binary_c-python/-/issues/new>
Indices and tables
==================
--
GitLab