Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arata-nvm committed Jan 31, 2022
1 parent b64753b commit 3916bbe
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
# mitnal

Twitter client for UEFI.

## Screenshot

![](Static/ScreenShot.png)

## Requirements

You need to enable "HTTP Protocol Stack Support" in your UEFI.

## How to build

Create a `MitnalPkg/Secrets` file as follows:

```c
static const CHAR8 *gConsumerKey = "<Your consumer key>";
static const CHAR8 *gConsumerSecret = "<Your consume secret>";
static const CHAR8 *gAccessToken = "<Your access token>";
static const CHAR8 *gAccessTokenSecret = "<Your access token secret>";
```

Then,

```bash
$ make docker/build
$ make run
```

## Usage

Here is a list of available command:

- `home`: show your timeline
- `tweet hello`: tweet 'hello'
Binary file added Static/ScreenShot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3916bbe

Please # to comment.