Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add clean documentation #1

Merged
merged 6 commits into from
Nov 3, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 91 additions & 1 deletion docs/run.md
Original file line number Diff line number Diff line change
@@ -1 +1,91 @@
# Run Library
# Dart DLC Documentation

## Table of Contents
1. [Introduction](#introduction)
2. [Getting Started](#getting-started)
1. [Prerequisites](#prerequisites)
2. [Installation](#installation)
3. [Usage](#usage)
4. [Testing](#testing)
5. [Contributing](#contributing)
6. [License](#license)

## 1. Introduction <a name="introduction"></a>

Provide a brief overview of your Dart Discreet Log Contractnt (DLC). Explain its purpose, benefits, and any other relevant information.

## 2. Getting Started <a name="getting-started"></a>

Explain how to set up and get your project running.

### 2.1 Prerequisites <a name="prerequisites"></a>

List the software and tools that users need to have installed on their system before they can use your DLC. For example:

- [Dart](https://dart.dev/get-dart)
- [Flutter](https://flutter.dev/) (if applicable)

### 2.2 Installation <a name="installation"></a>

Provide step-by-step instructions for users to install and set up your DLC. This might include cloning the Git repository and installing dependencies.

```bash
# Clone the repository
git clone https://github.com/Horus-Org/dart-dlc

# Change to the project directory
cd dartdlc

# Install dependencies
pub get
```

## 3. Usage <a name="usage"></a>

Explain how users can use your DLC in their own projects. Provide Dart code examples, explanations, and any configuration details.

```dart
// Example Dart code demonstrating how to use your DLC
import 'package:your_dlc_package/your_dlc_module.dart';

void main() {
final result = OracleInfo
print(result);
}
```

## 4. Testing <a name="testing"></a>

Detail how users can run tests to ensure the stability and correctness of your DLC.

### 4.1 Running Tests

Provide instructions on running tests using Dart's built-in test runner or any other testing framework you prefer.

```bash
# Run tests
dart test
```

### 4.2 Writing Tests

Explain how users can write their own tests for your DLC using the testing framework you've chosen.

```dart
// Example test case using the `oracle` package
import 'package:test/test.dart';

void main() {
test('Test case description', () {
// Declare your test data
var amount = 10; // a number
var price = 20.5; // a floating-point number

// Write your test expectations
expect(amount, isA<int>());
expect(price, isA<double>());
});
}

```
Specify the project's open-source license, such as MIT, Apache, or any other, and provide a link to the full license text.
Loading