Skip to content

Commit

Permalink
Move website to Docusaurus (#373)
Browse files Browse the repository at this point in the history
Summary:
![screenshot 2019-02-21 16 16 44](https://user-images.githubusercontent.com/3757713/53210860-2628a100-35f4-11e9-934c-2c82ff749a14.png)

![screenshot 2019-02-21 16 16 50](https://user-images.githubusercontent.com/3757713/53210866-2aed5500-35f4-11e9-9e8b-5943da7d0516.png)
Pull Request resolved: facebook#373

Differential Revision: D14178248

Pulled By: int3

fbshipit-source-id: 1d37b5a26beca3ea4158ff7995b0a7e6eeeffd4e
  • Loading branch information
JoelMarcey authored and facebook-github-bot committed Feb 22, 2019
1 parent 439468b commit 46da7a0
Show file tree
Hide file tree
Showing 69 changed files with 940 additions and 330 deletions.
2 changes: 2 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*/node_modules
*.log
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.DS_Store

**/*.o
**/*.lo
**/.deps
Expand Down Expand Up @@ -34,3 +36,9 @@
/build-cmake/
redex-src-strings-map.txt
pyredex/__pycache__

website/translated_docs
website/build/
website/yarn.lock
website/node_modules
website/i18n/*
10 changes: 10 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
FROM node:8.11.4

WORKDIR /app/website

EXPOSE 3000 35729
COPY ./docs /app/docs
COPY ./website /app/website
RUN yarn install

CMD ["yarn", "start"]
268 changes: 2 additions & 266 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,273 +1,9 @@
ReDex: An Android Bytecode Optimizer
====================================
# ReDex: An Android Bytecode Optimizer

ReDex is an Android bytecode (dex) optimizer originally developed at
Facebook. It provides a framework for reading, writing, and analyzing .dex
files, and a set of optimization passes that use this framework to improve the
bytecode. An APK optimized by ReDex should be smaller and faster than its
source.

# Quick Start Guide

## Dependencies

We use package managers to resolve third-party library dependencies.

### macOS

You will need Xcode with command line tools installed. To get the command line tools, use:
```
xcode-select --install
```

Install dependencies using homebrew:
```
brew install autoconf automake libtool python3
brew install boost jsoncpp zlib
```

### Ubuntu (64-bit)
```
sudo apt-get install \
g++ \
automake \
autoconf \
autoconf-archive \
libtool \
liblz4-dev \
liblzma-dev \
make \
zlib1g-dev \
binutils-dev \
libjemalloc-dev \
libiberty-dev \
libjsoncpp-dev
```

Redex requires boost version >= 1.58. The versions in the Ubuntu 14.04 and
14.10 repositories are too old. This script will install boost for you instead:
```
sudo ./get_boost.sh
```

If you're on ubuntu 16.04 or newer, the version in the repository is fine:
```
sudo apt-get install libboost-all-dev
```

### Experimental: Windows 10 (64-bit)

You need Visual Studio 2017. Visual Studio 2015 is also possible, but a couple of C++ compile errors need to be fixed. We use [vcpkg](https://github.com/Microsoft/vcpkg) for dependencies. Install vcpkg from their [document](https://github.com/Microsoft/vcpkg):

```
cd c:\tools
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
.\bootstrap-vcpkg.bat
.\vcpkg integrate install
```
Install necessary libraries with `x64-windows-static`:
```
.\vcpkg install boost --triplet x64-windows-static
.\vcpkg install zlib --triplet x64-windows-static
.\vcpkg install jsoncpp --triplet x64-windows-static
.\vcpkg install mman --triplet x64-windows-static
```

## Download, Build and Install

Get ReDex from GitHub:
```
git clone https://github.com/facebook/redex.git
cd redex
```

Now, build ReDex using autoconf and make.
```
# if you're using gcc, please use gcc-4.9
autoreconf -ivf && ./configure && make -j4
sudo make install
```

### Experimental: CMake for Mac, Linux, and Windows

Alternatively, build using CMake. Note that the current `CMakeLists.txt` only implements a rule for `redex-all` binary. We will support installation and testing soon.

Generate build files. By default, it uses Makefile:
```
# Assume you are in redex directory
mkdir build-cmake
cd build-cmake
# .. is the root source directory of Redex
cmake ..
```

If you prefer the ninja build system:
```
cmake .. -G Ninja
```

You can also provide `BUILD_TYPE` for Static Linking of dependencies. This is optional and defaults to Shared.

```
cmake .. -DBUILD_TYPE=Static
```

On Windows, first, get `CMAKE_TOOLCHAIN_FILE` from the output of `"vcpkg integrate install"`, and then:
```
cmake .. -G "Visual Studio 15 2017 Win64"
-DVCPKG_TARGET_TRIPLET=x64-windows-static
-DCMAKE_TOOLCHAIN_FILE="C:/tools/vcpkg/scripts/buildsystems/vcpkg.cmake"
```

Build `redex-all`:

```
cmake --build .
```

On Windows, you may build from Visual Studio. `Redex.sln` has been generated.

You should see a `redex-all` executable, and the executable should show about 45 passes.

```
./redex-all --show-passes
```

## Test

Optionally, you can run our unit test suite. We use gtest, which is downloaded
via a setup script.
```
./test/setup.sh
cd test
make check
```

## Usage

To use ReDex, first build your app and find the APK for it. Then run:
```
redex path/to/your.apk -o path/to/output.apk
```

If you want some statistics about each pass, you can turn on tracing:
```
export TRACE=1
```

The result `output.apk` should be smaller and faster than the
input. Enjoy!

# Documentation
Right now we have a limited amount of [documentation](docs/README.md) which describes a few
example Redex optimization passes as well as deployments of Redex (including Docker).

# More Information

The blog [Optimizing Android bytecode with ReDex](https://code.facebook.com/posts/1480969635539475/optimizing-android-bytecode-with-redex) provides an overview of the Redex project.

# Issues
Issues on GitHub are assigned priorities which reflect their urgency and how soon they are
likely to be addressed.
* P0: Unbreak now! A serious issue which should have someone working on it right now.
* P1: High Priority. An important issue that someone should be actively working on.
* P2: Mid Priority. An important issue which is in the queue to be processed soon.
* P3: Low Priority. An important issue which may get dealt with at a later date.
* P4: Wishlist: An issue with merit but low priority which is up for grabs but likely to be pruned if not addressed after a reasonable period.

# License

ReDex is MIT-licensed, see the LICENSE file in the root directory of this
source tree.

---

# FAQ

## I'm getting "Couldn't find zipalign. See README.md to resolve this." or other zipalign errors

`zipalign` is an optimization step that is bundled with the Android SDK. You
need to tell redex where to find it. For example, if you installed the SDK at
`/path/to/android/sdk`, try:
```
ANDROID_SDK=/path/to/android/sdk redex [... arguments ...]
```
You can alternatively add `zipalign` to your PATH, for example:
```
PATH=/path/to/android/sdk/build-tools/xx.y.zz:$PATH redex [... arguments ...]
```

Additionally, it's possible zipalign itself failed. In this case the stderr will be reported to aid debugging (for example, zipalign fails if you provide an output path that already exists).

## My app fails to install with `Failure [INSTALL_PARSE_FAILED_NO_CERTIFICATES]`

After you run redex, you'll need to re-sign your app. You can re-sign manually
using these instructions:
https://developer.android.com/tools/publishing/app-signing.html#signing-manually.

You can also tell redex to sign for you. If you want to sign with the debug
key, you can simply do:

```
redex --sign [ ... arguments ...]
```

If you want to sign with your release key, you'll need to provide the
appropriate args:

```
--sign Sign the apk after optimizing it
-s [KEYSTORE], --keystore [KEYSTORE]
-a [KEYALIAS], --keyalias [KEYALIAS]
-p [KEYPASS], --keypass [KEYPASS]
```

## My App crashes with `MethodNotFoundException`, `ClassNotFoundException`, `NoSuchFieldException`, or something similar. How do I fix this?

Redex probably deleted or renamed it. Redex is quite aggressive about deleting
things it deems are unreachable. But, often Redex doesn't know about reflection
or other complex ways an entity could be reached.

Here's how you ensure Redex will not delete or rename something:

Annotate any class, method, or field you want to keep with `@DoNotStrip`.

Add this to your redex config (at the uppermost level of the json) to
prevent deletion:
```
"keep_annotations": [
"Lcom/path/to/your/DoNotStrip;"
]
```

and add this to your config to prevent renaming:
```
"RenameClassesPassV2" : {
"dont_rename_annotated": [
"Lcom/path/to/your/DoNotStrip;"
]
}
```

and define `DoNotStrip`:

```
package com.path.to.your;
public @interface DoNotStrip {}
```

## How does this compare to ProGuard?

ReDex is conceptually similar to ProGuard, in that both optimize bytecode.
ReDex, however, optimizes .dex bytecode, while ProGuard optimizes .class
bytecode before it is lowered to .dex. Operating on .dex is sometimes an
advantage: you can consider the number of virtual registers used by a method
that is an inlining candidate, and you can control the layout of classes within
a dex file. But ProGuard has some capabilities that ReDex does not (for
example, ReDex will not remove unused method parameters, which ProGuard does).

## How about DexGuard?

DexGuard operates on dex, but we haven't evaluated it at all since it's closed
source. We don't use it at Facebook and we have no plans to start.
Go to https://fbredex.com for full documentation.
18 changes: 18 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: "3"

services:
docusaurus:
build: .
ports:
- 3000:3000
- 35729:35729
volumes:
- ./docs:/app/docs
- ./website/blog:/app/website/blog
- ./website/core:/app/website/core
- ./website/i18n:/app/website/i18n
- ./website/pages:/app/website/pages
- ./website/static:/app/website/static
- ./website/sidebars.json:/app/website/sidebars.json
- ./website/siteConfig.js:/app/website/siteConfig.js
working_dir: /app/website
9 changes: 0 additions & 9 deletions docs/README.md

This file was deleted.

6 changes: 4 additions & 2 deletions docs/buck.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Using ReDex with BUCK
---------------------
---
id: buck
title: Using ReDex with Buck
---

ReDex already has a deep integration with BUCK.
Steps:
Expand Down
6 changes: 4 additions & 2 deletions docs/Config.md → docs/config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Configuring ReDex
-----------------
---
id: configuring
title: Configuring ReDex
---

ReDex can be configured to run different optimizations or to alter the behavior
of existing optimizations. While this isn't always necessary, it's helpful to
Expand Down
5 changes: 4 additions & 1 deletion docs/docker.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Docker Container Deployments
---
id: docker
title: Docker Container Deployments
---

## Dockerfiles and DockerHub Images

Expand Down
9 changes: 0 additions & 9 deletions docs/examples/README.md

This file was deleted.

Loading

0 comments on commit 46da7a0

Please sign in to comment.