Skip to content
Snippets Groups Projects
Commit bfd3629f authored by chc1234567890's avatar chc1234567890
Browse files

feat: modified README

parent 036cfb8a
No related branches found
No related tags found
1 merge request!1merge
Pipeline #406044 failed
# Team Fudan 2024 Software Tool
<<<<<<< HEAD
If your 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
......@@ -8,24 +7,16 @@ code of your team's software tool in this repository, `main` branch. By the **Wi
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.
> repository will be automatically deleted by the end of the season.
## Description
=======
## Description
>>>>>>> e6f39ff (feat: add frontend)
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might
be unfamiliar with (for example your team wiki). 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.
## Installation
<<<<<<< HEAD
=======
>>>>>>> e6f39ff (feat: add frontend)
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
......@@ -33,19 +24,13 @@ specific context like a particular programming language version or operating sys
installed manually, also add a Requirements subsection.
## Usage
<<<<<<< HEAD
=======
>>>>>>> e6f39ff (feat: add frontend)
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.
## Contributing
<<<<<<< HEAD
=======
>>>>>>> e6f39ff (feat: add frontend)
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started.
......@@ -57,8 +42,5 @@ the likelihood that the changes inadvertently break something. Having instructio
helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
<<<<<<< HEAD
=======
>>>>>>> e6f39ff (feat: add frontend)
Show your appreciation to those who have contributed to the project.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment