If you team competes in the [**Software & AI** village](https://competition.igem.org/participation/villages) or wants to
apply for the [**Best Software Tool** prize](https://competition.igem.org/judging/awards), you **MUST** host all the
code of your team's software tool in this repository, `main` branch. By the **Wiki Freeze**, a
[release](https://docs.gitlab.com/ee/user/project/releases/) will be automatically created as the judging artifact of
this software tool. You will be able to keep working on your software after the Grand Jamboree.
> If your team does not have any software tool, you can totally ignore this repository. If left unchanged, this
repository will be automatically deleted by the end of the season.
## Description
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might
Hello! This is the OSU-FABE iGEM team. If your reading this then you want to use our program to optimize lead sequences for a Type 3 Secretion System. If you need background info or are interested in our process developing the project then follow this link to our 2023 wiki!
be unfamiliar with (for example your team wiki). A list of Features or a Background subsection can also be added here.
https://2023.igem.wiki/ohio-state-fabe/index.html
If there are alternatives to your project, this is a good place to list differentiating factors.
## Installation
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew.
# IGEMGUI
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
## Running instructions
specific context like a particular programming language version or operating system or has dependencies that have to be
### Windows
installed manually, also add a Requirements subsection.
1. Download the newest release of `IGEMGUI.zip` from the [releases](https://github.com/shmoe6/IGEMGUI/releases) page.
2. Extract the zip file to a directory of the **same name**: `IGEMGUI`.
3. Double click the `windowsrun.bat` file.
### Mac
1. Download the newest release of `IGEMGUI.zip` from the [releases](https://github.com/shmoe6/IGEMGUI/releases) page.
2. Extract the zip file to a directory of the **same name**: `IGEMGUI`.
3. Double click the `macrun.command` file.
___
## To View Source Code:
1. Navigate to the newest release of IGEMGUI from the [releases](https://github.com/shmoe6/IGEMGUI/releases) page.
2. Click on the `Source code (zip)` hyperlink under the `Assets` section of the release.
3. Extract the zip file and the code should be visible from there.
## Usage
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of
The user inputs a sequence of 20 nucleotides. From here, the user then inputs a activity value that would be determined experimentally for the nucleotide sequence. Next, run the program and through 10 generations, the program will then give you the potential optimized sequence. Be sure to note that this sequence may have some faults as the program makes some innate assumptions.
usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably
include in the README.
## Contributing
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
If you are thinking about contributing to the program, read through the code find what you want to change and message us through our igem email in our wiki-page(link above). We here at the Ohio State University are open to all changes and will consider them.
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.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce
It will always be a mission for the Ohio State iGEM team to promote the further advancement and curiousity of newer iGEM teams.
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.
## Authors and acknowledgment
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
With special thanks to Anna Bontempo who was able to translate the code and optimize it.
