Skip to content

Commit

Permalink
📝Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
soaibsafi committed Oct 20, 2024
1 parent c7cf5ed commit 2125e82
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 19 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@
<img src="https://img.shields.io/github/issues/se-buw/fm-playground" alt="GitHub issues">
<img src="https://img.shields.io/github/actions/workflow/status/se-buw/fm-playground/ci.yml" alt="Build">
<img src="https://img.shields.io/github/license/se-buw/fm-playground" alt="GitHub License">
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fwakapi.soaib.me%2Fapi%2Fcompat%2Fshields%2Fv1%2Fsoaib%2Finterval%3Aany%2Fproject%3Afm-playground&style=flat&label=dev&color=%233b71ca
" alt="Wakapi">
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fwakapi.soaib.me%2Fapi%2Fcompat%2Fshields%2Fv1%2Fsoaib%2Finterval%3Aany%2Fproject%3Afm-playground&style=flat&label=dev&color=%233b71ca" alt="Wakapi">
<hr>
</div>

Expand All @@ -30,14 +29,13 @@ For more updates, examples, and tutorials, please visit the [formal-methods.net]
## Development

### Requirements
- Python >= 3.9.0
- Node >= 18.0.0
- Python >= 3.10.0
- Node >= 20.0.0
- PostgreSQL >= 15.0 (optional) - use sqlite3 for development
- Docker >= 20.10.0 (optional)
- Docker Compose >= 1.27.0 (optional)



### Installation

- [TODO]
Expand All @@ -54,12 +52,13 @@ cp .env.example .env
```
- Run the following command:
```bash
docker-compose up -d
docker compose up -d
```



## Contributing
TODO: Create a contributing guide

Contributions are welcome! Please refer to the [contributing guidelines](CONTRIBUTING.md) for detailed instructions.

Expand Down
20 changes: 7 additions & 13 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,31 @@
- [Table of Contents](#table-of-contents)
- [Description](#description)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Installation](#installation)
- [🚧TODO: Update with v2.0.0 architecture (use docker compose for now)](#todo-update-with-v200-architecture-use-docker-compose-for-now)
- [Docker](#docker)
- [Contributing](#contributing)
- [License](#license)

## Description

This is the backend for the FM Playground application. FM Playground is a web application that allows users to run formal methods tools in the browser. Currently, the application supports the following tools:

- [Limboole](https://fmv.jku.at/limboole/) - A SAT-based tool for Boolean reasoning.
- [Z3](https://github.com/Z3Prover/z3) - A SMT solver developed at Microsoft Research.
- [nuXmv ](https://nuxmv.fbk.eu/) - A symbolic model checker for the analysis of synchronous finite-state and infinite-state systems.
- ~~[Alloy](https://alloytools.org/)~~ (served from [alloy-app](../alloy-app/)) - A declarative modeling language for software systems.
This is the backend for the FM Playground application. FM Playground is a web application that allows users to run formal methods tools in the browser.


## Prerequisites

List any dependencies that must be installed before running the application.

- Python v3.9.0 or higher
- Python v3.10.0 or higher
- Flask v2.0.0 or higher
- Z3
- nuXmv
- Docker v20.10.0 or higher (optional)
- Docker Compose v1.27.0 or higher (optional)


## Getting Started

### Installation
## Installation

### 🚧TODO: Update with v2.0.0 architecture (use docker compose for now)

1. Clone the repository:

Expand Down

0 comments on commit 2125e82

Please sign in to comment.