mirror of
https://github.com/CompeyDev/codenamer.luau.git
synced 2025-05-04 10:13:46 +01:00
chore(examples): include example descriptions
This commit is contained in:
parent
c74c8a1d01
commit
e6a2d39537
3 changed files with 22 additions and 0 deletions
|
@ -1,3 +1,10 @@
|
||||||
|
--[[
|
||||||
|
examples/custom.luau
|
||||||
|
|
||||||
|
Description: A slightly modified version of the simple example, including
|
||||||
|
custom dictionaries.
|
||||||
|
]]--
|
||||||
|
|
||||||
local Codenamer = require("../dist/codenamer")
|
local Codenamer = require("../dist/codenamer")
|
||||||
local stdio = require("@lune/stdio")
|
local stdio = require("@lune/stdio")
|
||||||
local process = require("@lune/process")
|
local process = require("@lune/process")
|
||||||
|
|
|
@ -1,3 +1,11 @@
|
||||||
|
--[[
|
||||||
|
examples/simple.luau
|
||||||
|
|
||||||
|
Description: A basic codenamer example, which requests the user for a
|
||||||
|
number of codenames to generate, the way to format them, and
|
||||||
|
then generates and prints them.
|
||||||
|
]]--
|
||||||
|
|
||||||
local Codenamer = require("../dist/codenamer")
|
local Codenamer = require("../dist/codenamer")
|
||||||
local stdio = require("@lune/stdio")
|
local stdio = require("@lune/stdio")
|
||||||
local process = require("@lune/process")
|
local process = require("@lune/process")
|
||||||
|
|
|
@ -1,3 +1,10 @@
|
||||||
|
--[[
|
||||||
|
examples/tostring.luau
|
||||||
|
|
||||||
|
Description: Codenamer implements a custom tostring metamethod, which returns a "generic type"
|
||||||
|
based on the state of the codenamer instance.
|
||||||
|
]]--
|
||||||
|
|
||||||
local Codenamer = require("../dist/codenamer")
|
local Codenamer = require("../dist/codenamer")
|
||||||
|
|
||||||
local codenamer = Codenamer.new()
|
local codenamer = Codenamer.new()
|
||||||
|
|
Loading…
Add table
Reference in a new issue